Add CIGAR =/X entry to version history appendix #743
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
These CIGAR operations were added in 07dc1c6 in July 2010, which was the initial addition of the TeX specification; they were not present in the previous Pages document. It's so long ago as to be barely relevant now, but it's worth mentioning them as requiring VN:1.3 rather than VN:1.0. In the SAM regexp in §1.4, write the operations in the familiar canonical order (though it doesn't affect the meaning of the regexp). Define \cigarops{...} to improve the formatting of lists of CIGAR operations like "M/I/D" by making the slashes non-\tt, and also use this in SAMtags.tex.
|
Alternatively, |
|
My preference would be to keep it explicit. It's obvious what “reference-consuming” etc mean if you read the CIGAR section. But one of the first things we learn from editing specs or maintaining software like samtools is that People Don't Read… |
jkbonfield
approved these changes
Nov 16, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The
=andXCIGAR operations were added to SAM in 07dc1c6 in July 2010, which was the initial addition of the TeX specification; they were not present in the previous Pages document. It's so long ago as to be barely relevant now, but it's worth adding them to the history appendix and identifying them as requiring VN:1.3 rather than VN:1.0.See the comments on this biostars posting for the motivating context.
In the SAM regexp in §1.4, write the operations in the familiar canonical order (though it doesn't affect the meaning of the regexp). Define
\cigarops{...}to improve the formatting of lists of CIGAR operations like "M/I/D" by making the slashes non-\tt, and also use this in SAMtags.tex.